home *** CD-ROM | disk | FTP | other *** search
/ ASP Advantage 1994 2nd Q2 / The Association of Shareware Professionals - The Official ASP Advantage (2nd Quarter)(1994).bin / files / progming / basicxr / basicxr.doc < prev    next >
Encoding:
Text File  |  1994-01-04  |  9.5 KB  |  270 lines
  1.                      BasicXR Cross Reference Utility            v 1.3
  2.                      Copyright 1991-1993  JNGoodale
  3.                         _______
  4.                    ____|__     |                (R)
  5.                 --|       |    |-------------------
  6.                   |   ____|__  |  Association of
  7.                   |  |       |_|  Shareware
  8.                   |__|   o   |    Professionals
  9.                 -----|   |   |---------------------
  10.                      |___|___|    MEMBER
  11.  
  12.  
  13.     Files included in BASXRF.EXE:
  14.  
  15.                     BASICXR.COM     Executable program
  16.                     BASICXR.DOC     This file
  17.                     BASICXRW.QB4    Starter file for Custom Res Words
  18.                     BASICXRW.PDS    Microsoft PDS Custom Res Words
  19.                     README.TXT      Brief documentation
  20.                     PRODUCTS.TXT    Description of other products
  21.                     REGISTER.DOC    Registration form (UnRegistered Version
  22.                                       Only)
  23.     -------------------------------------------------------------------------
  24.     This document covers the following:
  25.  
  26.             1.  General description
  27.             2.  Start-up
  28.             3.  Printer control codes
  29.             4.  Printing to a file
  30.             5.  Forcing a page eject
  31.             6.  Creating a file of Reserved Words
  32.             7.  Requirements/Limitations
  33.             8.  Error messages
  34.             9.  Support
  35.            10.  Registration
  36.            11.  Shareware Concept/Ombudsman information
  37.  
  38.     ====================================================================
  39.  
  40.     1.  GENERAL DESCRIPTION
  41.  
  42.         This program will cross reference a program written in Basic
  43.         and saved as an ASCII file.  It will create any combination
  44.         of the following three options:
  45.  
  46.                     Formatted program listing
  47.                     User label/line number and variable cross reference
  48.                     Reserved word cross reference
  49.  
  50.         If you are running the unregisered version, a registration reminder
  51.         and option to register are displayed at the beginning and end of the
  52.         program.
  53.  
  54.         The registered version functions identically, but the registration 
  55.         reminder is removed and it is about  6K shorter.  You receive this 
  56.         version when you register.
  57.  
  58.                                Page 1 of 5
  59.  
  60.  
  61.  
  62.     2.  START-UP
  63.  
  64.         To execute the program, simply enter BASICXR followed optionally 
  65.         by "/ switches", as described below:
  66.  
  67.                 BASICXR/M  will force the program to monochrome display.
  68.  
  69.                 BASICXR/E  will send printer control codes for Epson
  70.                            compatible printers.  See # 3 below.
  71.  
  72.                 BASICXR/D  will send printer control codes for DeskJet
  73.                            compatible printers.  See # 3 below.
  74.  
  75.         The "/M" switch can be used in conjunction with either of the
  76.         printer switches.  Order and case are not important.
  77.  
  78.  
  79.     3.  PRINTER CONTROL CODES
  80.  
  81.         If you elect to print compressed pitch for either an Epson or
  82.         DeskJet compatible printer, start the program with the
  83.         appropriate switch (/E or /D).  The program will send the
  84.         following printer control codes to your printer (or to the
  85.         output file, if you elect to output to a file for later printing):
  86.  
  87.                                 /D (DeskJet)            /E (Epson)
  88.  
  89.                 Reset           CHR$(27);"E"            CHR$(27);"@"
  90.                 Compressed      CHR$(27);"(s16.67H"     CHR$(15)
  91.  
  92.                 Line width      110 characters          120 characters
  93.                 Lines/page      54                      54
  94.  
  95.         In both cases the program resets the printer at the end.
  96.  
  97.         *  If you do not execute the program with one of the printer 
  98.            switches, no control codes are sent.  Line width is 80, 
  99.            lines/page 54.
  100.  
  101.     4.  PRINTING TO A FILE
  102.  
  103.         By entering "f" or "F" at the prompt you can direct the output
  104.         to a file for later printing.  The name of the file created will
  105.         be the same base name as your input source file with an extension
  106.         of ".XRF".  It will be written to the same path as the source.
  107.  
  108.  
  109.  
  110.                                   Page  2 of 5
  111.  
  112.  
  113.  
  114.  
  115.     5.  FORCING A PAGE EJECT
  116.  
  117.         If you would like to force a page eject in the program listing,
  118.         simply insert a line with two single quotes as the only text on
  119.         the line - '' - NOT a double quote (").
  120.  
  121.         The single quote is shorthand for REM, so the two single quotes
  122.         will not affect your program, but will trigger a page eject in
  123.         BasicXR.
  124.  
  125.     6.  CREATING A FILE OF RESERVED WORDS
  126.  
  127.         BasicXR has a built in table of Microsoft QuickBasic 4.5 reserved
  128.         words.  For another dialect of Basic you can create your own set
  129.         in a file that must be called "BASICXRW.TXT".  This is simply a
  130.         text file of the reserved words.  Two starter files (BASICXRW.QB4
  131.         and BASICXRW.PDS) are supplied with this program which you can use 
  132.         to edit to create your own list.  It must be renamed to 
  133.         "BASICXRW.TXT" for it to take effect.
  134.  
  135.         If your programs are written in Microsoft QuickBasic 4.5 you do
  136.         not need this file.
  137.  
  138.         Maximum size of BASICXRW.TXT is 400 entries.
  139.         Maximum record length for each entry is 16.
  140.  
  141.     7.  REQUIREMENTS/LIMITATIONS
  142.  
  143.         Minimum requirements to run BasicXR are:
  144.  
  145.                 IBM compatible computer
  146.                 Monochrome or color monitor
  147.                 Printer (unless printing to a file)
  148.                 DOS 2.11 or higher
  149.                 256K
  150.  
  151.         Programs to be cross-referenced must be saved in ASCII and have
  152.         the extension ".BAS".
  153.  
  154.         The program assumes Microsoft Basic dialects.  I do not guarantee
  155.         any other versions of Basic, although it might work.
  156.  
  157.         It will work with either line numbers (as in GWBasic) or line
  158.         labels (as in QuickBasic), but not both within the same program
  159.         (which QuickBasic allows for, but BasicXR doesn't).
  160.  
  161.         Customized Reserved Word file - Maximum 400 entries, Maximum
  162.         record length 16.
  163.  
  164.                                   Page  3 of 5
  165.  
  166.  
  167.  
  168.         The size of the program it can handle is based on how much main
  169.         memory you have (up to 640K) and how many references there are.
  170.         If it runs out of room for the reference table, the program
  171.         notifies you, marks the listing where referencing will stop, and
  172.         continues the listing, if that option is turned on.
  173.  
  174.         The solution at this point would be to break the program into
  175.         several parts and then run each part thru BasicXR.
  176.  
  177.     8.  ERROR MESSAGES
  178.  
  179.         The following error messages may occur:
  180.  
  181.             No *.BAS files
  182.             No options entered.  Ending
  183.             This is not an ASCII (text) file.  Ending
  184.             Reached max of 400 Reserved Words .. ignoring excess
  185.             Label reference table exceeded
  186.  
  187.         Except where "Ending" is stated, you are given the option to
  188.         [ESC] to quit or [ENTER] to try again.
  189.  
  190.     9.  SUPPORT
  191.  
  192.         Registered owners will receive free support for three months
  193.         after registration by contacting me thru US mail, CompuServe or
  194.         phone at:
  195.  
  196.                 Jane N. Goodale
  197.                 7826 Littlejohn Court     
  198.                 Charlotte,  NC  28227
  199.  
  200.                 (704)-537-0329
  201.  
  202.                 CIS PPN 71116,302
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.                                   Page  4 of 5
  215.  
  216.  
  217.  
  218.     10. REGISTRATION
  219.  
  220.         Registration is available for $15.  You can fill out and print
  221.         the registration form within the program BASICXR.EXE or from
  222.         the order blank "REGISTER.DOC".
  223.  
  224.         If you distribute copies of this program, please assure that
  225.         all files and documentation are present.
  226.  
  227.     11. SHAREWARE CONCEPT/OMBUDSMAN INFORMATION
  228.  
  229.         Shareware distribution gives users a chance to try software
  230.         before buying it.  If you try a Shareware program and continue
  231.         using it, you are expected to register.
  232.  
  233.         Shareware is a distribution method, not a type of software.  You
  234.         should find software that suits your needs and pocketbook, whether
  235.         it's commercial or Shareware.  The Shareware system makes fitting
  236.         your needs easier, because you can try before you buy.  And because
  237.         the overhead is low, prices are low also.  Shareware has the
  238.         ultimate money-back guarantee -- if you don't use the product,
  239.         you don't pay for it!
  240.  
  241.  
  242.                Association Of Shareware Professionals Ombudsmen
  243.  
  244.         This program is produced by a member of the Association of
  245.         Shareware Professionals (ASP).  ASP wants to make sure that the
  246.         shareware principle works for you.  If you are unable to resolve a
  247.         shareware-related problem with an ASP member by contacting the
  248.         member directly, ASP may be able to help.  The ASP Ombudsman can
  249.         help you resolve a dispute or problem with an ASP member, but does
  250.         not provide technical support for members' products.  Please write
  251.         to the ASP Ombudsman at P.O. Box 5786, Bellevue, WA 98006 or send
  252.         a Compuserve message via easyplex to ASP Ombudsman 70007,3536
  253.  
  254.  
  255.                          .... End of BASICXR.DOC ....
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.                                   Page  5 of 5
  270.